API Direct Debit - Payment Status
Berfungsi untuk melakukan pengecekan status debit
Service Info
HTTP Method | POST |
---|---|
Service Code | 55 |
Http Method | POST |
Path | ...{version}/debit/status |
Header
Header Name | Tipe Data | Wajib | Deskripsi |
---|---|---|---|
Content-Type | String | Y | application/json |
Authorization | String | Y | Mewakili access_token dari sebuah permintaan; string dimulai dengan kata kunci Bearer diikuti oleh access_token (contoh: Bearer eyJraWQiOi...Jzc29zIiwiY ). |
Authorization-Customer | String | Y | Mewakili access_token dari pelanggan; string dimulai dengan kata kunci Bearer diikuti oleh access_token (contoh: Bearer eyJrsWaiOi...Jzc523awiY ). |
X-TIMESTAMP | String | Y | Waktu lokal klien saat ini dalam format yyyy-MM-ddTHH:mm:ss+07:00. |
X-SIGNATURE | String | Y | X-Signature menggunakan algoritma symmetric signature HMAC_SHA512. Formula stringToSign adalah HTTPMethod + ":" + EndpointUrl + ":" + AccessToken + ":" + Lowercase(HexEncode(SHA-256(minify(RequestBody)))) + ":" + TimeStamp . |
X-PARTNER-ID | String | Y | Client ID (diberikan pada saat onboarding). |
X-EXTERNAL-ID | String | Y | Nomor referensi yang harus unik pada hari yg sama, disarankan menggunakan UUID v4. |
X-DEVICE-ID | String | Y | Identifikasi perangkat dimana layanan API sedang diakses oleh pengguna akhir (customer). |
CHANNEL-ID | String | Y | 00001 untuk PJP dan 00002 untuk non PJP. |
Body
Parameter | Tipe Data | Wajib | Deskripsi |
---|---|---|---|
originalPartnerReferenceNo | String | Y | Pengidentifikasi transaksi asli pada sistem konsumen layanan Length: <= 64 karakter |
originalReferenceNo | String | Y | Pengidentifikasi transaksi pada sistem penyedia layanan Length: <= 64 karakter |
serviceCode | String | Y | Kode layanan dari layanan yang akan diakses Length: <= 2 karakter |
merchantId | String | Y | Pengidentifikasi merchant pada sistem penyedia layanan Length: <= 64 karakter |
additionalInfo | Object | Y | Informasi Tambahan |
Request samples
- JSON
- CURL
{
"originalPartnerReferenceNo": "2020102900000000000001",
"originalReferenceNo": "5037424",
"serviceCode": "50",
"merchantId": "1212723",
"additionalInfo": {
"deviceId": "12345679237",
"channel": "mobilephone"
}
}
curl --location --request POST '../v1.0/debit/status' \
--header 'X-TIMESTAMP: 2023-01-27T13:51:00+07:00' \
--header 'X-SIGNATURE: RwABEherf+3MTBhIf6vtju6ko+YOFFKWLGgHCD5RwX1I17JCKVn8ffc/TenEIly85InhuIcKCDqDrxbIBhaKEg==' \
--header 'X-PARTNER-ID: 085224a9-4b42-4f7d-959f-4452f8a9a1ff' \
--header 'X-EXTERNAL-ID: 024a31b6-e0c8-429a-9d41-83a2f44b6844' \
--header 'X-DEVICE-ID: android-20013adf6cdd8123f' \
--header 'CHANNEL-ID: 12345' \
--header 'Authorization: Bearer bb005fcb-dea9-499a-9e7a-bcf651b2334e' \
--header 'Authorization-Customer:Bearer 5b8bbaf8-4aca-4072-9ea8-d85bed65105f' \
--header 'Content-Type: application/json' \
--data '{
"originalPartnerReferenceNo": "2020102900000000000001",
"originalReferenceNo": "5037424",
"serviceCode": "50",
"merchantId": "1212723",
"additionalInfo": {
"deviceId": "12345679237",
"channel": "mobilephone"
}
}'
Response Structure
Parameter | Tipe Data | Deskripsi |
---|---|---|
responseCode | String | Kode respons Length: <= 7 karakter |
responseMessage | String | Deskripsi respons Length: <= 150 karakter |
originalReferenceNo | String | Pengidentifikasi transaksi asli pada penyedia layanan Length: <= 64 karakter |
serviceCode | String | Pengidentifikasi transaksi pada sistem konsumen layanan Length: <= 32 karakter |
latestTransactionStatus | String | Status transaksi terakhir 00 - berhasil, 07 - tidak ditemukan Length: <= 2 karakter |
transactionStatusDesc | String | Deskripsi status transaksi Length: <= 50 karakter |
amount | Object | Jumlah |
paidTime | String | Tanggal transaksi dalam format ISO 8601 Length: <= 25 karakter |
Response samples
{
"responseCode": "2005500",
"responseMessage": "Successful",
"originalReferenceNo": "5037424",
"latestTransactionStatus": "00",
"transactionStatusDesc": "Success",
"amount": {
"value": "65000.00",
"currency": "IDR"
},
"paidTime": "2023-01-27T17:28:00.667+07:00"
}
List Response Code API Direct Debit - Payment Status
Response Code | Response Message | Description |
---|---|---|
2005500 | Success | Sukses |
4005501 | Invalid field format { field name } | Format invalid |
4005502 | Invalid mandatory field {field name} | Format pada bidang wajib tidak ada atau tidak valid |
4015500 | Unauthorized. Invalid Signature | X-Signature salah |
4095500 | Cannot use same X-EXTERNAL-ID in same day | X-External-ID sudah pernah digunakan di hari yang sama |
4045501 | Bad Request | Request header ada yang salah / kurang |
4045501 | Unauthorized. Client Forbidden Access API | Partner tidak dapat mengakses api terkait |